# Conf

SpringBoot 是基于约定的，所以很多配置都有默认值，但如果想使用自己的配置替换默认配置的话就可以使用配置文件配置，SpringBoot 默认会从 Resources 目录下加载application*.properties或application*.yml（application*.yaml）文件

此处不再介绍 properties 配置文件（键值对形式），仅介绍 yml 配置文件

# YAML 简介

YML 文件格式是 YAML (YAML Aint Markup Language)编写的文件格式，YAML 是一种直观的能够被电脑识别的的数据数据序列化格式，并且容易被人类阅读，容易和脚本语言交互的，可以被支持 YAML 库的不同的编程语言程序导入，比如： C/C++, Ruby, Python, Java, Perl, C#, PHP 等。YML 文件是以数据为核心的，比传统的 xml 方式更加简洁。

YML 文件的扩展名可以使用.yml 或者.yaml。

# YAML 语法

基本语法：

• k:(空格)v：表示一对键值对（空格必须有）
• 以空格的缩进来控制层级关系；只要是左对齐（相同空格缩进）的一列数据，都是同一个层级的；属性和值也是大小写敏感

# 配置字面量数据

普通的值（数字，字符串，布尔）

• k: v：字面量直接来写；字符串默认不用加上单引号或者双引号；
  • ""：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思
    • name: "zhangsan \n lisi"：输出；zhangsan 换行 lisi
  • ''：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据
    • name: ‘zhangsan \n lisi’：输出；zhangsan \n lisi

name: zhangsan

# 配置对象、Map 数据

teacher:
  name: zhangsan
  age: 38

student: { name: lisi, age: 18 }

# 配置数组（List、Set）数据

city:
  - beijing
  - shanghai

province: [shangxi, hebei, guangdong]

#元素是对象形式
dog:
  - name: wangcai
    age: 3
  - name: goudan
    age: 5

cat: [{ name: xiaobai, age: 1 }, { name: xiaolv, age: 2 }]

【注意】：value 与之间的 - 之间存在一个空格

# 配置文件值注入

# @Value

利用在 4.2 中语法所写的配置

@RestController
public class HelloController {

    @Value("${dog[0].name}")//数组或集合中保存对象
    private String name;

    @RequestMapping("/hello")
    public String hello(){
        return "hello spring boot "+name;
    }
}

# @ConfigurationProperties

通过注解@ConfigurationProperties(prefix="配置文件中的key的前缀")可以将配置文件中的配置自动与实体进行映射

利用在 4.2 中语法所写的配置。需要提供 setter。但是配置的数组、List、Set 不清楚怎么获取

@Component
@RestController
@ConfigurationProperties(prefix = "teacher")
public class HelloController {

    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @RequestMapping("/hello")
    public String hello(){
        return "hello spring boot "+name;
    }
}

@ConfigurationProperties报错 Not registered via @EnableConfigurationProperties or marked as Spring component，添加了@Component注解后解决了

若出现以下提示，需要配置文件执行器，并在类中定义好属性和 set 方法后，如果在配置文件中编写配置会有提示！

<!--配置文件执行器配置-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

@Value 和 @ConfigurationProperties 比较

• 松散语法绑定：last_name = last-name = lastName 他们取的值都是相同的
• 配置文件 yml 还是 properties 他们都能获取到值，怎么选择呢？
  • 若我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；
  • 若我们专门编写了一个 javaBean 来和配置文件映射，我们就直接使用@ConfigurationProperties

# @PropertySource

• @PropertySource：加载指定的配置文件，由于@ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值；

  /**
   * 将配置文件中配置的每一个属性的值，映射到这个组件中
   * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
   *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
   *
   * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
   */
  @PropertySource(value = {"classpath:person.properties"})
  @Component
  @ConfigurationProperties(prefix = "person")
  public class Person {
  
      private String lastName;
      private Integer age;
      private Boolean boss;
  
  

# @Configuration 和 @Bean

• @ImportResource：导入 Spring 的配置文件，如 beans.xml，加载 bean，让配置文件里面的内容生效

  • Spring Boot 里面没有 Spring 的配置文件，我们自己编写的配置文件，也不能自动识别；

    想让 Spring 的配置文件生效，加载进来；@ImportResource 标注在一个配置类上

  <bean id="helloService" class="com.cuzz.springboot.service.HelloService"></bean>
  
  

  @ImportResource(locations = {"classpath:beans.xml"})
  @SpringBootApplication
  public class SpringbootApplication {
  
  	public static void main(String[] args) {
  		SpringApplication.run(SpringbootApplication.class, args);
  	}
  }
  
  

• 还是写配置类吧！利用@Configuration 和@Bean

  @Configuration
  public class MyAppConfig {
      // 将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
      @Bean
      public HelloService helloService02(){
          System.out.println("配置类@Bean给容器中添加组件了...");
          return new HelloService();
      }
  }
  
  

# 配置文件占位符

• 随机数

  ${random.value}
  ${random.int}
  ${random.long}
  ${random.int(10)}
  ${random.int[1024,65536]}
  

• 占位符获取之前配置的值，如果没有可以使用**:指定默认值**

  person.last-name=张三${random.uuid}
  person.age=${random.int}
  # 没有取到:后面是默认值
  person.dog.name=${person.hello:hello}_dog
  

# Profile

Profile 是 Spring 对不同环境（开发、测试、上线等）提供不同配置功能的支持，可以通过激活、 指定参数等方式快速切换环境

# 多 Profile 文件

• 我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml，{profile}名任起
  • 默认使用 application.properties 的配置；

# yml 支持多文档块方式

server:
  port: 8081
spring:
  profiles:
    active: pro #指定激活哪个环境，不设置则为这个默认的

---
server:
  port: 8083
spring:
  profiles: dev #指定属于哪个环境

---
server:
  port: 8084
spring:
  profiles: pro #指定属于哪个环境

• 若文档块都没有指定环境，则默认使用最后一个
• 若某个文档块没有指定环境，则默认使用那个，一般第一个不指定环境

# 激活指定 profile

• 在默认配置文件中指定 spring.profiles.active=dev

• 命令行参数

  java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev
  

• 虚拟机参数

  -Dspring.profiles.active=dev
  

在 IDEA 中也可以配置，以下三者任选其一，但权限 Program arguments > Active profiles > VM options

# 配置文件加载位置及顺序

起步依赖里好像不是这样？？？

• Spring Boot 启动会扫描以下位置的 application.properties/yml 文件作为 Spring boot 的默认配置文件

  • –file:./config/ ——项目目录下的 config

  • –file:./ ——项目目录下

  • –classpath:/config/ ——resources 目录下的 config

  • –classpath:/ ——resources 目录下

    优先级由高到底，高优先级的配置会覆盖低优先级的配置；SpringBoot 会从这四个位置全部加载主配置文件；互补配置；

• 我们还可以通过spring.config.location来改变默认的配置文件位置

  • 用于运维时，项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默认加载的这些配置文件共同起作用形成互补配置；

    java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties
    
    

所有支持的配置加载来源查看这里第 24 节 Externalized Configuration

SpringBoot 也可以从以下位置加载配置； 优先级从高到低；高优先级的配置覆盖低优先级的配置，所有的配置会形成互补配置

1. 命令行参数：所有的配置都可以在命令行上进行指定。多个配置用空格分开； --配置项=值

   java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc
   

2. 来自 java:comp/env 的 JNDI 属性

3. Java 系统属性（System.getProperties()）

4. 操作系统环境变量

5. RandomValuePropertySource 配置的 random.*属性值

由 jar 包外向 jar 包内进行寻找

优先加载带 profile

1. jar 包外部的 application-{profile}.properties 或 application.yml(带 spring.profile)配置文件
2. jar 包内部的 application-{profile}.properties 或 application.yml(带 spring.profile)配置文件

再来加载不带 profile

1. jar 包外部的 application.properties 或 application.yml(不带 spring.profile)配置文件
2. jar 包内部的 application.properties 或 application.yml(不带 spring.profile)配置文件
3. @Configuration 注解类上的@PropertySource
4. 通过 SpringApplication.setDefaultProperties 指定的默认属性

# 常用配置

# IDEA 热部署

热部署的原理是，检测到 target 下的 class 文件发生变化后自动重启，所以需要对修改的文件进行编译，否则无效

热部署失效：原因是因为 Intellij IEDA 默认情况下不会自动编译，需要对 IDEA 进行自动编译的设置

Shift + Ctrl + Alt + / （Mac：Shift + Command + Alt + /），选择 Registry...

但是还是推荐使用 Jrebel！！！

# Banner

在 Spring Boot 启动的时候会有一个默认的启动图案

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.2.2.RELEASE)

我们在 src/main/resources 目录下新建一个 banner.txt，通过网站生成字符串，将网站生成的字符复制到文件中。甚至可以直接放入图片，名称改为 banner 即可。[banner]有旗帜，横幅、口号的意思。详细查看官方文档。

常用属性设置：

• ${AnsiColor.BRIGHT_RED}：设置控制台中输出内容的颜色
• ${application.version}：用来获取 MANIFEST.MF 文件中的版本号
• ${application.formatted-version}：格式化后的 ${application.version} 版本信息
• ${spring-boot.version}：Spring Boot 的版本号
• ${spring-boot.formatted-version}：格式化后的 ${spring-boot.version} 版本信息
• ......

# 项目名

spring:
  application:
    name: study-spring-boot # 名称，不知道在哪显示

# 端口、上下文

server:
  port: 80 # 端口
  servlet:
    context-path: /conanan #上下文，之后访问需要带/conanan

# 日志

Spring Boot 默认继承 Logback

logging:
  file:
    name: ../logs/study-spring-boot.log # 相对项目路径。path属性设置有问题，没用
  level:
    root: warn
    org.springframework.web: debug
    org.hibernate: error

Log files rotate(转化) when they reach 10 MB and, as with console output, ERROR-level, WARN-level, and INFO-level messages are logged by default. Size limits can be changed using the logging.file.max-size property. Previously rotated files are archived indefinitely unless the logging.file.max-history property has been set. The total size of log archives can be capped using logging.file.total-size-cap. When the total size of log archives exceeds that threshold, backups will be deleted. To force log archive cleanup on application startup, use the logging.file.clean-history-on-start property.

# 关闭特定的自动配置

关闭特定的自动配置使用 @SpringBootApplication 注解的 exclude 参数即可，这里以关闭数据源的自动配置为例

@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})

# 自定义 Parent

若需要使用自定义的 parent，不使用官方提供的，可以按如下配置（仅作为示例）：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>geektime.demo</groupId>
	<artifactId>helloworld</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>HelloWorld</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
	</properties>

	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-dependencies</artifactId>
				<version>2.1.1.RELEASE</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<version>2.1.1.RELEASE</version>
				<executions>
					<execution>
						<goals>
							<goal>repackage</goal>
						</goals>
					</execution>
				</executions>
			</plugin>
		</plugins>
	</build>
</project>